Optimize RmtCommand serialization #74

CoryCharlton · 2025-02-26T17:49:13Z

Description

Optimize RmtCommand serialization as suggested by @eeegs

Motivation and Context

Provides a 50% improvement in RmtCommand serialization as suggested by @eeegs here: nanoframework/Home#1540 (comment)

| --------------------------------------------------------------------------------------- |
| MethodName                      | IterationCount | Mean                  | Min  | Max   |
| --------------------------------------------------------------------------------------- |
| SerializeCommands_Original      | 2000           | 9.8049999999999997 ms | 0 ms | 20 ms |
| SerializeCommands_Improved_1540 | 2000           | 4.825 ms              | 0 ms | 10 ms |
| --------------------------------------------------------------------------------------- |

How Has This Been Tested?

Locally
Unit tests
Benchmarks

Screenshots

Types of changes

Improvement (non-breaking change that improves a feature, code or algorithm)
Bug fix (non-breaking change which fixes an issue with code or algorithm)
New feature (non-breaking change which adds functionality to code)
Breaking change (fix or feature that would cause existing functionality to change)
Config and build (change in the configuration and build system, has no impact on code or features)
Dependencies (update dependencies and changes associated, has no impact on code or features)
Unit Tests (add new Unit Test(s) or improved existing one(s), has no impact on code or features)
Documentation (changes or updates in the documentation, has no impact on code or features)

Checklist:

My code follows the code style of this project (only if there are changes in source code).
My changes require an update to the documentation (there are changes that require the docs website to be updated).
I have updated the documentation accordingly (the changes require an update on the docs in this repo).
I have read the CONTRIBUTING document.
I have tested everything locally and all new and existing tests passed (only if there are changes in source code).
I have added new tests to cover my changes.

Summary by CodeRabbit

Chores
- Enhanced dependency management across key project modules, ensuring more consistent and reliable performance.
- Implemented tighter version control and integrity checks to reduce the potential for conflicts and improve overall stability.

coderabbitai · 2025-02-26T17:49:21Z

Important

Review skipped

Review was skipped due to path filters

⛔ Files ignored due to path filters (2)

nanoFramework.Hardware.Esp32.Rmt.Benchmarks/SerializeCommandsBenchmark.cs is excluded by none and included by none
nanoFramework.Hardware.Esp32.Rmt/Properties/AssemblyInfo.cs is excluded by none and included by none

CodeRabbit blocks several paths by default. You can override this behavior by explicitly including those paths in the path filters. For example, including **/dist/** will override the default block on the dist directory, by removing the pattern from both the lists.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This pull request adds new packages.lock.json files in two project directories. The files define and lock dependency versions used in the respective projects, with each file including version details, resolved dependency versions, and content hashes for integrity checks. One file targets the Benchmarks project with several nanoFramework libraries, while the other targets the UnitTests project with its specific dependencies.

Changes

File	Change Summary
nanoFramework.Hardware.Esp32.Rmt.{Benchmarks,UnitTests}/packages.lock.json	New file(s) added to lock dependency versions. The Benchmarks file specifies dependencies including nanoFramework.Benchmark (v1.0.102), nanoFramework.CoreLibrary (v1.17.1), nanoFramework.Logging (v1.1.142), nanoFramework.Runtime.Native (v1.7.9), nanoFramework.System.Collections (v1.5.62), nanoFramework.System.Diagnostics.Stopwatch (v1.2.815), and nanoFramework.System.Text (v1.3.29); the UnitTests file lists nanoFramework.CoreLibrary (v1.17.1) and nanoFramework.TestFramework (v3.0.68), each with content hashes.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

josesimoes

Nice improvement! Thanks.

josesimoes · 2025-02-26T18:10:11Z

@CoryCharlton any chance you can look into what sonarcloud analysis is pointing? If its not doable, let me know and I'll override the warning.

CoryCharlton · 2025-02-26T18:57:22Z

@CoryCharlton any chance you can look into what sonarcloud analysis is pointing? If its not doable, let me know and I'll override the warning.

It was complaining about duplicated code in the benchmark project. I removed the code since it was a duplicate benchmark that is already covered in the latest commit.

josesimoes · 2025-02-26T19:51:29Z

Perfect! Thanks for looking into it.

- If we're changing the API, this should be bumped

josesimoes

LGTM!

sonarqubecloud · 2025-02-26T19:57:21Z

Quality Gate passed

Issues
4 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

CoryCharlton added 4 commits February 26, 2025 09:21

Moving RmtCommand serialization to RmtCommandSerializer

cf69f61

Add unit tests

a500301

Add benchmarks

5eeedfe

Optimize SerializeCommands

17c588a

nfbot added Type: enhancement New feature or request Type: Unit Tests labels Feb 26, 2025

josesimoes approved these changes Feb 26, 2025

View reviewed changes

CoryCharlton mentioned this pull request Feb 26, 2025

Update nanoFramework.Hardware.Esp32.Rmt signatures nanoframework/nf-interpreter#3126

Merged

13 tasks

Remove SerializeCommands_Improved_1540

c1536d9

Bump native assembly version

e908596

- If we're changing the API, this should be bumped

josesimoes approved these changes Feb 26, 2025

View reviewed changes

josesimoes merged commit ddc9d47 into nanoframework:main Feb 26, 2025
6 checks passed

CoryCharlton deleted the improve_rmtcommand_serialization branch February 26, 2025 20:17

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Optimize RmtCommand serialization #74

Optimize RmtCommand serialization #74

Uh oh!

CoryCharlton commented Feb 26, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Feb 26, 2025 •

edited

Loading

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

josesimoes left a comment

Uh oh!

josesimoes commented Feb 26, 2025

Uh oh!

CoryCharlton commented Feb 26, 2025

Uh oh!

josesimoes commented Feb 26, 2025

Uh oh!

josesimoes left a comment

Uh oh!

sonarqubecloud bot commented Feb 26, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Optimize RmtCommand serialization #74

Optimize RmtCommand serialization #74

Uh oh!

Conversation

CoryCharlton commented Feb 26, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Motivation and Context

How Has This Been Tested?

Screenshots

Types of changes

Checklist:

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Feb 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Changes

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

josesimoes left a comment

Choose a reason for hiding this comment

Uh oh!

josesimoes commented Feb 26, 2025

Uh oh!

CoryCharlton commented Feb 26, 2025

Uh oh!

josesimoes commented Feb 26, 2025

Uh oh!

josesimoes left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Feb 26, 2025

Quality Gate passed

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

CoryCharlton commented Feb 26, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Feb 26, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)